<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Clear scroll API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'clear-scroll-api.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/clear-scroll-api.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/clear-scroll-api.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/clear-scroll-api.html" rel="nofollow" target="_blank">../en/clear-scroll-api.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="search.html">Search APIs</a></span>
»
<span class="breadcrumb-node">Clear scroll API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="scroll-api.html">« Scroll API</a>
</span>
<span class="next">
<a href="search-template.html">Search Template »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="clear-scroll-api"></a>Clear scroll API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/clear-scroll-api.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Clears the search context and results for a
<a class="xref" href="search-request-body.html#request-body-search-scroll" title="Scroll">scrolling search</a>.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE /_search/scroll
{
    "scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1984.console"></div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clear-scroll-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/clear-scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">DELETE /_search/scroll/&lt;scroll_id&gt;</code>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span></p>
<p><code class="literal">DELETE /_search/scroll</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clear-scroll-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/clear-scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;scroll_id&gt;</code>
</span>
</dt>
<dd>
<p>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span>
(Optional, string)
Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use <code class="literal">_all</code>.
</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>Scroll IDs can be long. We recommend only specifying
scroll IDs using the <a class="xref" href="clear-scroll-api.html#clear-scroll-api-scroll-id-param"><code class="literal">scroll_id</code> request body
parameter</a>.</p>
</div>
</div>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clear-scroll-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/clear-scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">scroll_id</code>
</span>
</dt>
<dd>
<p>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span>
(Optional, string)
Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use <code class="literal">_all</code>.
</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>Scroll IDs can be long. We recommend only specifying
scroll IDs using the <a class="xref" href="clear-scroll-api.html#clear-scroll-api-scroll-id-param"><code class="literal">scroll_id</code> request body
parameter</a>.</p>
</div>
</div>
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clear-scroll-api-request-body"></a>Request body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/clear-scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<a id="clear-scroll-api-scroll-id-param"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">scroll_id</code>
</span>
</dt>
<dd>
(Required, string or array of strings)
Scroll IDs to clear. To clear all scroll IDs, use <code class="literal">_all</code>.
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clear-scroll-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/clear-scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">succeeded</code>
</span>
</dt>
<dd>
(boolean)
If <code class="literal">true</code>, the request succeeded. This does not indicate whether any scrolling
search requests were cleared.
</dd>
<dt>
<span class="term">
<code class="literal">num_freed</code>
</span>
</dt>
<dd>
(integer)
Number of scrolling search requests cleared.
</dd>
</dl>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="scroll-api.html">« Scroll API</a>
</span>
<span class="next">
<a href="search-template.html">Search Template »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>